PurchaseHeader entities
| Name | Type | Is Mandatory |
|---|---|---|
| PurchaseHeaderId | Int32 | |
| ContactId | Int32 | |
| PurchaseDate | DateTime | |
| StoreId | Int32 | |
| PurchaseIdentifier | String | |
| CheckoutIdentifier | String | |
| CurrencyId | String | |
| Amount | Decimal | |
| TaxFreeAmount | Decimal | |
| DiscountAmount | Decimal | |
| DiscountTypeId | Int16 | |
| RefCurrencyId | String | |
| RefChangeRate | Decimal | |
| RefAmount | Decimal | |
| RefTaxFreeAmount | Decimal | |
| RefDiscountAmount | Decimal | |
| SalePersonCode | String | |
| PurchaseTypeId | Int16 | |
| PurchaseStatusId | Int16 | |
| FreeField1 | String | |
| FreeField2 | String | |
| FreeField3 | String | |
| FreeField4 | String | |
| FreeField5 | String | |
| FreeFieldDateTime1 | DateTime | |
| FreeFieldDateTime2 | DateTime | |
| FreeFieldDateTime3 | DateTime | |
| FreeFieldDateTime4 | DateTime | |
| FreeFieldDateTime5 | DateTime | |
| FreeFieldNumber1 | Decimal | |
| FreeFieldNumber2 | Decimal | |
| FreeFieldNumber3 | Decimal | |
| FreeFieldNumber4 | Decimal | |
| FreeFieldNumber5 | Decimal | |
| FreeFieldBoolean1 | Boolean | |
| FreeFieldBoolean2 | Boolean | |
| FreeFieldBoolean3 | Boolean | |
| FreeFieldBoolean4 | Boolean | |
| FreeFieldBoolean5 | Boolean | |
| BrandId | Int32 | |
| DeletionFlag | Boolean | |
| PurchaseStatusDate | DateTime | |
| LoyaltyCardId | Int32 | |
| StoreIdentifier | String | |
| SourceId | Int16 | |
| VoucherId | Int32 | |
| Contact | Contact | |
| PurchaseDetails | Collection of PurchaseDetail | |
| Brand | Brand | |
| Store | Store | |
| Currency | Currency | |
| DiscountType | DiscountType | |
| PurchaseType | PurchaseType | |
| PurchaseStatus | PurchaseStatus | |
| LoyaltyPoints | Collection of LoyaltyPoint | |
| LoyaltyCard | LoyaltyCard | |
| RefCurrency | Currency | |
| Source | Source | |
| Voucher | Voucher |
| Action Name | Method | Parameters | Description | Return | |
|---|---|---|---|---|---|
| SumPurchaseDetail | POST |
|
Compute Sum of chosen column of related PurchaseDetail entities | Decimal | |
Select all PurchaseHeaders
https://customerapi.fts-crm360.com/data/PurchaseHeaders()
HttpMethod : GET
Json Result :
[
{
"PurchaseHeaderId" : "11",
"ContactId" : "28",
"PurchaseDate" : "2020-06-17T00:00:00",
"StoreId" : "56",
"PurchaseIdentifier" : "M6ZX qOhw",
"CheckoutIdentifier" : "1ZTnC5AVCp7n",
"CurrencyId" : "fs8D3xh4",
"Amount" : "9143736.673",
"TaxFreeAmount" : "7539584.919",
"DiscountAmount" : "8946528.372",
"DiscountTypeId" : "6",
"RefCurrencyId" : "B8cPPwLswc5t567iLFo",
"RefChangeRate" : "9762178.765",
"RefAmount" : "3866744.536",
"RefTaxFreeAmount" : "7842396.662",
"RefDiscountAmount" : "3265734.846",
"SalePersonCode" : "mNgkVILekB",
"PurchaseTypeId" : "9",
"PurchaseStatusId" : "5",
"FreeField1" : "EUbyCBILYJHSD b gEs",
"FreeField2" : "rLJovpe",
"FreeField3" : "FmQNFhq8 BXg",
"FreeField4" : "yODZRQTue",
"FreeField5" : "8MUR3",
"FreeFieldDateTime1" : "2000-01-23T00:00:00",
"FreeFieldDateTime2" : "2019-08-22T00:00:00",
"FreeFieldDateTime3" : "1996-08-13T00:00:00",
"FreeFieldDateTime4" : "2007-01-30T00:00:00",
"FreeFieldDateTime5" : "2011-08-12T00:00:00",
"FreeFieldNumber1" : "6179925.251",
"FreeFieldNumber2" : "5728891.354",
"FreeFieldNumber3" : "2766318.378",
"FreeFieldNumber4" : "2999675.251",
"FreeFieldNumber5" : "7235631.549",
"FreeFieldBoolean1" : "False",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "False",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "True",
"BrandId" : "92",
"DeletionFlag" : "True",
"PurchaseStatusDate" : "2000-12-14T00:00:00",
"LoyaltyCardId" : "60",
"StoreIdentifier" : "ZQYr ftNNLe6wWoBeG",
"SourceId" : "1",
"VoucherId" : "4"
},
{
"PurchaseHeaderId" : "98",
"ContactId" : "31",
"PurchaseDate" : "2021-02-15T00:00:00",
"StoreId" : "84",
"PurchaseIdentifier" : "nY9mtMRiksdwioC",
"CheckoutIdentifier" : "zPMbIyOWUbYLj",
"CurrencyId" : "F i9MGvlf MXKpKQ6d",
"Amount" : "9521646.826",
"TaxFreeAmount" : "3381976.126",
"DiscountAmount" : "4982733.766",
"DiscountTypeId" : "2",
"RefCurrencyId" : "f5PDv",
"RefChangeRate" : "1724492.332",
"RefAmount" : "2451214.117",
"RefTaxFreeAmount" : "9342826.427",
"RefDiscountAmount" : "9899631.219",
"SalePersonCode" : "3gCGZHgDAI2PVx",
"PurchaseTypeId" : "7",
"PurchaseStatusId" : "4",
"FreeField1" : "lLZtFcQScje 9K9AEDx",
"FreeField2" : "CZDBWMmBkj",
"FreeField3" : "6Ej1k5",
"FreeField4" : "Dyz6iAOB83NQs8 6",
"FreeField5" : "GWW30Ns3",
"FreeFieldDateTime1" : "2007-12-28T00:00:00",
"FreeFieldDateTime2" : "2015-10-04T00:00:00",
"FreeFieldDateTime3" : "2022-03-01T00:00:00",
"FreeFieldDateTime4" : "2022-07-02T00:00:00",
"FreeFieldDateTime5" : "2013-07-22T00:00:00",
"FreeFieldNumber1" : "2523763.551",
"FreeFieldNumber2" : "2262434.892",
"FreeFieldNumber3" : "4735936.112",
"FreeFieldNumber4" : "4424781.434",
"FreeFieldNumber5" : "7763372.146",
"FreeFieldBoolean1" : "True",
"FreeFieldBoolean2" : "True",
"FreeFieldBoolean3" : "False",
"FreeFieldBoolean4" : "False",
"FreeFieldBoolean5" : "False",
"BrandId" : "38",
"DeletionFlag" : "False",
"PurchaseStatusDate" : "2013-11-11T00:00:00",
"LoyaltyCardId" : "36",
"StoreIdentifier" : "H YqwASXkN",
"SourceId" : "6",
"VoucherId" : "53"
},
...
]
Select PurchaseHeader by Id
https://customerapi.fts-crm360.com/data/PurchaseHeaders(11)
HttpMethod : GET
Json Result :
{
"PurchaseHeaderId" : "44",
"ContactId" : "62",
"PurchaseDate" : "1999-02-21T00:00:00",
"StoreId" : "89",
"PurchaseIdentifier" : "KBevdIg X",
"CheckoutIdentifier" : "YjdExa",
"CurrencyId" : "UNpes4txW O U",
"Amount" : "6333245.493",
"TaxFreeAmount" : "2462917.981",
"DiscountAmount" : "8393852.792",
"DiscountTypeId" : "2",
"RefCurrencyId" : "CfIOJ4W6",
"RefChangeRate" : "2495217.776",
"RefAmount" : "1435341.573",
"RefTaxFreeAmount" : "7481846.688",
"RefDiscountAmount" : "6152699.774",
"SalePersonCode" : "BNfD1rlLzJp",
"PurchaseTypeId" : "2",
"PurchaseStatusId" : "1",
"FreeField1" : "zj3nycD",
"FreeField2" : "9AD9JyZZWzS2rJTBAp",
"FreeField3" : "dBn5 Y81VCG37WIPd 2",
"FreeField4" : "yxZz13MfoP1lH",
"FreeField5" : "l1WGOlL7CWO5",
"FreeFieldDateTime1" : "2005-09-06T00:00:00",
"FreeFieldDateTime2" : "2010-11-13T00:00:00",
"FreeFieldDateTime3" : "2011-12-08T00:00:00",
"FreeFieldDateTime4" : "2022-11-20T00:00:00",
"FreeFieldDateTime5" : "2020-05-22T00:00:00",
"FreeFieldNumber1" : "1222768.192",
"FreeFieldNumber2" : "5212575.739",
"FreeFieldNumber3" : "4734871.695",
"FreeFieldNumber4" : "7974851.393",
"FreeFieldNumber5" : "5134779.272",
"FreeFieldBoolean1" : "False",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "True",
"FreeFieldBoolean4" : "False",
"FreeFieldBoolean5" : "True",
"BrandId" : "26",
"DeletionFlag" : "True",
"PurchaseStatusDate" : "2018-09-15T00:00:00",
"LoyaltyCardId" : "36",
"StoreIdentifier" : "jPHYffcqYCvM1BXVd1m",
"SourceId" : "1",
"VoucherId" : "77"
}
Create a PurchaseHeader
https://customerapi.fts-crm360.com/data/PurchaseHeaders()
HttpMethod : POST
Json Post :
{
"ContactId" : "90",
"PurchaseDate" : "2020-04-11T00:00:00",
"StoreId" : "76",
"PurchaseIdentifier" : "5qt8ijO47pR445N",
"CheckoutIdentifier" : "Rwq q5OoH",
"CurrencyId" : "AJQLqaXtk0vs efT",
"Amount" : "9414694.852",
"TaxFreeAmount" : "2491418.851",
"DiscountAmount" : "6798523.456",
"DiscountTypeId" : "9",
"RefCurrencyId" : "4XA1irM",
"RefChangeRate" : "1747531.764",
"RefAmount" : "7819462.438",
"RefTaxFreeAmount" : "4613929.569",
"RefDiscountAmount" : "6526532.156",
"SalePersonCode" : "bu90s4Ncs2cT",
"PurchaseTypeId" : "8",
"PurchaseStatusId" : "8",
"FreeField1" : "tIyVTjFlzJt",
"FreeField2" : "fGdE5qX84BbM",
"FreeField3" : "v 6GHMVx",
"FreeField4" : "CPGP7WHKq atW",
"FreeField5" : "yhnb irs",
"FreeFieldDateTime1" : "2013-04-03T00:00:00",
"FreeFieldDateTime2" : "1996-06-28T00:00:00",
"FreeFieldDateTime3" : "2012-06-22T00:00:00",
"FreeFieldDateTime4" : "2012-10-28T00:00:00",
"FreeFieldDateTime5" : "1999-11-26T00:00:00",
"FreeFieldNumber1" : "5794755.488",
"FreeFieldNumber2" : "4467872.816",
"FreeFieldNumber3" : "7366994.946",
"FreeFieldNumber4" : "1742657.672",
"FreeFieldNumber5" : "8897212.889",
"FreeFieldBoolean1" : "False",
"FreeFieldBoolean2" : "True",
"FreeFieldBoolean3" : "False",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "True",
"BrandId" : "19",
"DeletionFlag" : "False",
"PurchaseStatusDate" : "2007-01-10T00:00:00",
"LoyaltyCardId" : "48",
"StoreIdentifier" : "DlEKuvBaHWCmG y",
"SourceId" : "9",
"VoucherId" : "34"
}
Informations :
- Non mandatory fields are optional for Json Post
Update a PurchaseHeader
https://customerapi.fts-crm360.com/data/PurchaseHeaders(11)
HttpMethod : PUT
Json Post :
{
"PurchaseHeaderId" : "84",
"ContactId" : "37",
"PurchaseDate" : "2021-07-23T00:00:00",
"StoreId" : "74",
"PurchaseIdentifier" : "F R3H ubZUGAHO",
"CheckoutIdentifier" : "y c9yqc3wDtIi0P",
"CurrencyId" : "m9afq",
"Amount" : "9866779.751",
"TaxFreeAmount" : "7625898.996",
"DiscountAmount" : "5584326.235",
"DiscountTypeId" : "1",
"RefCurrencyId" : "uC4J0WF fJR AkX",
"RefChangeRate" : "3427158.241",
"RefAmount" : "2451849.198",
"RefTaxFreeAmount" : "2671589.243",
"RefDiscountAmount" : "8478372.713",
"SalePersonCode" : "5gHo l5suR7BvOpuC",
"PurchaseTypeId" : "2",
"PurchaseStatusId" : "2",
"FreeField1" : "vxIMzpqvDPNA",
"FreeField2" : "9NGiagPCan73V6ko",
"FreeField3" : "Hk0wG",
"FreeField4" : "X5 V5K",
"FreeField5" : "eD5RwAiKmq6 TI",
"FreeFieldDateTime1" : "2001-01-14T00:00:00",
"FreeFieldDateTime2" : "2005-01-29T00:00:00",
"FreeFieldDateTime3" : "2009-04-16T00:00:00",
"FreeFieldDateTime4" : "2017-04-30T00:00:00",
"FreeFieldDateTime5" : "1998-01-03T00:00:00",
"FreeFieldNumber1" : "1126298.176",
"FreeFieldNumber2" : "6249828.912",
"FreeFieldNumber3" : "6185994.892",
"FreeFieldNumber4" : "6468164.473",
"FreeFieldNumber5" : "9985156.551",
"FreeFieldBoolean1" : "False",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "True",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "False",
"BrandId" : "2",
"DeletionFlag" : "True",
"PurchaseStatusDate" : "2013-02-21T00:00:00",
"LoyaltyCardId" : "73",
"StoreIdentifier" : "oEFiDPkg",
"SourceId" : "3",
"VoucherId" : "77"
}
Informations :
- Non mandatory fields are optional for Json Post
Patch a PurchaseHeader
https://customerapi.fts-crm360.com/data/PurchaseHeaders(11)
HttpMethod : PATCH
Json Post :
{
"RefAmount" : "5373633.543",
"FreeFieldBoolean5" : "True",
"FreeFieldDateTime3" : "2003-04-24T00:00:00",
"RefDiscountAmount" : "9829131.387"
}
Informations :
- Non mandatory fields are optional for Json Post
Delete a PurchaseHeader
https://customerapi.fts-crm360.com/data/PurchaseHeaders(11)
HttpMethod : DELETE